Add Docs for AudioEncoder #717
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
NicolasHug
commented
Jun 9, 2025
There was a problem hiding this comment.
Changed in this file, as well as the files renaming, are meant to separate our "tutorials" page into 2 separate sections: one for decoding, one for encoding.
NicolasHug
commented
Jun 9, 2025
scotts
reviewed
Jun 9, 2025
scotts
reviewed
Jun 9, 2025
| order = [ | ||
| "audio_encoding.py", | ||
| ] | ||
|
|
There was a problem hiding this comment.
Can we add a comment explaining that we have two top-level galleries, and for that reason, we need to figure out which gallery we're using (decoding versus encoding)? I was real confused until I concluded that must be what's going on.
|
Moving the examples into decoding and encoding subdirectories makes sense, but I'm curious: will that change the resulting tutorial URL? We already have some pointers to these tutorials floating around blogs and social media. |
scotts
approved these changes
Jun 9, 2025
Dan-Flores
reviewed
Jun 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds docstrings and a tutorial for the
AudioEncoder, plus some minor changes listed in the comments below